Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
CMgntAccessSetting Class Reference

CMgntAccessSetting is used to control telnet and ssh access into the asa. More...

Public Member Functions

AccessProtocol getAccessProtocol ()
 Return the access protocol eTelnet =0, eSsh, eHttp. More...
 
ip getAllowedIp ()
 Return the ip address that is allowed to access the asa. More...
 
ip getAllowedMask ()
 Return the mask address of the host that is allowed to access the asa. More...
 
int getAllowedPrefix ()
 Return the prefix of the host that is allowed to access the asa. More...
 
string getSrcNameIf ()
 Return the nameif at which the host can access into. More...
 
int getTimeout ()
 Return the timeout of the connection. More...
 
void setTimeout (int)
 Set the timeout for the connection. More...
 
string toString ()
 Return the configuration in string. More...
 
void setIpv4 (bool)
 set the access setting to ipv4 when it permits an ipv4 address More...
 
bool isIpv4 ()
 Return true if the setting allows ipv4 address and false if the setting allows ipv6 address. More...
 
bool isActive ()
 Return true if the setting has all of the required configuration for example (ip address is set on the nameif interface) More...
 
void setActive (bool)
 Set the setting to be active or inactive. More...
 

Detailed Description

CMgntAccessSetting is used to control telnet and ssh access into the asa.

Member Function Documentation

◆ getAccessProtocol()

AccessProtocol CMgntAccessSetting::getAccessProtocol ( )

Return the access protocol eTelnet =0, eSsh, eHttp.

◆ getAllowedIp()

ip CMgntAccessSetting::getAllowedIp ( )

Return the ip address that is allowed to access the asa.

Returns
ip, value is the ip address that is allowed to access the asa.

◆ getAllowedMask()

ip CMgntAccessSetting::getAllowedMask ( )

Return the mask address of the host that is allowed to access the asa.

Returns
ip, value is the mask address of the host that is allowed to access the asa.

◆ getAllowedPrefix()

int CMgntAccessSetting::getAllowedPrefix ( )

Return the prefix of the host that is allowed to access the asa.

Returns
int, value is the the prefix of the host that is allowed to access the asa.

◆ getSrcNameIf()

string CMgntAccessSetting::getSrcNameIf ( )

Return the nameif at which the host can access into.

Returns
string, value is the nameif at which the host can access into.

◆ getTimeout()

int CMgntAccessSetting::getTimeout ( )

Return the timeout of the connection.

Returns
int, value is the timeout of the connection.

◆ isActive()

bool CMgntAccessSetting::isActive ( )

Return true if the setting has all of the required configuration for example (ip address is set on the nameif interface)

Returns
bool, value is true if the setting has all of the required configuration.

◆ isIpv4()

bool CMgntAccessSetting::isIpv4 ( )

Return true if the setting allows ipv4 address and false if the setting allows ipv6 address.

Returns
bool, value is true if the setting allows ipv4 address and false if the setting allows ipv6 address.

◆ setActive()

void CMgntAccessSetting::setActive ( bool  )

Set the setting to be active or inactive.

Parameters
isActive,trueto set to active, false to inactive.

◆ setIpv4()

void CMgntAccessSetting::setIpv4 ( bool  )

set the access setting to ipv4 when it permits an ipv4 address

Parameters
isIpv4- true if ipv4; false if ipv6

◆ setTimeout()

void CMgntAccessSetting::setTimeout ( int  )

Set the timeout for the connection.

Parameters
timeout- time in minutes

◆ toString()

string CMgntAccessSetting::toString ( )

Return the configuration in string.

Returns
string, value is the configuration string.

The documentation for this class was generated from the following file: